/*
 * Copyright 2010 Yannick Stucki (yannickstucki.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.yannickstucki.android.musicqueue.communication;

/**
 * An interface which exposes commanding control over the displayed songs.
 * 
 * @author Yannick Stucki (yannickstucki@gmail.com)
 *
 */
public interface ISongCommander {
  
  /**
   * Plays/resumes the current song.
   */
  void play();

  /**
   * Pauses the current song.
   */
  void pause();
  
  /**
   * Toggles play/pause on the current song.
   */
  void playPause();
  
  /**
   * Causes the shuffle effect: every song expect the top song is being replaced.
   */
  void shuffle();

  /**
   * Notify that a song has been removed.
   */
  void notifySongRemoved();

  /**
   * Notify that the current song has changed.
   */
  void notifyCurrentSongChanged();
  
  /**
   * Seeks to a certain time in milliseconds in the current song.
   */
  void seekTo(int milliseconds);
}
